Skip to main content
POST
Cancel Replenishment Task

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Headers

Idempotency-Key
string
required

Caller-generated retry identity unique to this task cancellation.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9._:-]+$

Path Parameters

id
integer<int32>
required

Warehouse identity.

task_id
integer<int64>
required

Replenishment task identity.

Required range: x >= 1

Body

application/json
expected_task_revision
integer
required

Task revision observed by the caller.

Required range: x >= 1
expected_lease_version
integer
required

Claim lease version observed by the caller.

Required range: x >= 0
reason_code
enum<string>
required

Structured cancellation reason.

Available options:
no_longer_needed,
wrong_quantity,
location_problem,
operator_unavailable,
other,
operator_request
Required string length: 1 - 64
reason
string | null

Optional operator explanation; a non-empty explanation is required for other or to retire a blocked, unclaimed root.

Maximum string length: 255

Response

Task state after the committed cancellation.

resource
ReplenishmentTask · object

Durable, read-only snapshot of Replenishment work. Quantity fields are expressed in the replenished Product's units. In Product quanta at the applicable LCM, qty_planned_total equals the sum of unpicked, custody, placed, canceled, short/exception, and externally satisfied quantities. Independently rounded decimal fields may not sum exactly. Mutations use the task_revision and claim_lease_version compare-and-swap values.

included
object

Empty relationship expansion dictionary.

meta
object

Additional metadata pertaining to the response.